Model Attribute Description

The HL7 attribute classCode describes this class as a maintained device (system) role.

Implementation in XML Instance

The XML attribute classCode is fixed to "MNT".

Schema Constraint

The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute id identifies the Accredited System which is making or made the query to CP-IS

Implementation in XML Instance

The XML element id is populated in the following way:

• The XML attribute root shall contain an OID with the value "1.2.826.0.1285.0.2.0.107"
• The XML attribute extension shall contain the Accredited System identifier.

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
• The XML attribute extension is fixed to "COCD_TP145104GB01#System"

Schema Constraint

• The attribute root is prohibited in the schema and therefore does not appear in the "on the wire" instance
  
• The attribute extension is prohibited in the schema and therefore does not appear in the "on the wire" instance.

A link to the organisation.

A link to the role of the person nominated to be responsible for the CP-IS queries.

Model Attribute Description

The HL7 attribute typeCode describes this class as an indirect authority.

Implementation in XML Instance

The XML attribute classCode is fixed to "INDAUTH".

Schema Constraint

The attribute typeCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
• The XML attribute extension is fixed to "COCD_TP145104GB01#assignedPerson"

Schema Constraint

• The attribute root is prohibited in the schema and therefore does not appear in the "on the wire" instance
  
• The attribute extension is prohibited in the schema and therefore does not appear in the "on the wire" instance.

A link to the assigned entity.

Model Attribute Description

The HL7 attribute classCode describes this class as an assigned role. An assigned role is a type of agent in which, the player is a person employed by a scoping organisation.

Implementation in XML Instance

The XML attribute classCode is fixed to "ASSIGNED".

Schema Constraint

• The XML attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute code uses a code from any available vocabulary to describe the person's job role.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

When the JobRoleName vocabulary is used then:

• The XML attribute code shall contain the code from the JobRoleName vocabulary
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.124"
• The XML attribute displayName shall carry the description associated with the code in the JobRoleName vocabulary

When an alternative vocabulary is used then:

• The XML attribute code shall contain the code from the alternative vocabulary
• The XML attribute codeSystem shall contain the OID for the alternative vocabulary
• The XML attribute displayName shall carry the description from the alternative vocabulary

A link to the assigned person.

Model Attribute Description

The HL7 attribute classCode describes this class as a person.

Implementation in XML Instance

The XML attribute classCode is fixed to "PSN".

Schema Constraint

• The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of a person.

Implementation in XML Instance

The XML attribute determinerCode is fixed to "INSTANCE".

Schema Constraint

• The attribute determinerCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute name provides a name associated with the person who is the author.

Implementation in XML Instance

The Person Name Structured with optional Use and optional Valid Time flavour of the PN data type is the recommended format for the author's name. This information is carried in the XML element name as follows:

• The XML element prefix should contain the author's title
• The XML element given should contain the author's forenames; there can be as many occurrences of the XML element as required.
  
• The XML element family should contain the author's surname
• The XML element suffix may contain any suffix for the author
  

Additionally the XML attribute use of the XML element name should be used to indicate the type of name; the recommended codes to be used are listed below:

Note some of the codes listed are NHS extensions, these are marked with an *

Code	Definition
L	Legal
PREFERRED *	Preferred name

Additionally the XML element validTime of the XML element name may be used to indicate the time when the name is valid/was valid for the author, some uses are shown below:

• A point in time when the name details are known to be valid
  
• A start and end time
• To represent the period of time the author is/was known by this name.
  
• A start time only to indicate when the name is/was valid from for the author.
  
• An end time only to indicate that the name is/was only valid for the author until a certain date.

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
• The XML attribute extension is fixed to "COCD_TP145104GB01#assignedPerson"

Schema Constraint

• The attribute root is prohibited in the schema and therefore does not appear in the "on the wire" instance
  
• The attribute extension is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute classCode describes this class as an organisation.

Implementation in XML Instance

The XML attribute classCode is fixed to "ORG".

Schema Constraint

• The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of an organisation.

Implementation in XML Instance

The XML attribute determinerCode is fixed to "INSTANCE".

Schema Constraint

• The attribute classCode is prohibited in the schema and therefore does not appear in the "on the wire" instance.
  

Model Attribute Description

The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation which employs the author. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes.

Implementation in XML Instance

When ODS site code is used then the XML element id is populated in the following way:

• The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2"
• The XML attribute extension shall contain the ODS site code.

When ODS organisation code is used then the XML element id is populated in the following way:

• The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1"
• The XML attribute extension shall contain the ODS organisation code.

Model Attribute Description

The HL7 attribute name uses the description of the organisation associated with the ODS code.

Implementation in XML Instance